<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilpuf: xpuf_defs.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilpuf
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xpuf__defs_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">xpuf_defs.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the xilpuf API IDs. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   kpt  01/04/22 Initial release
2.3   ng   11/22/23 Fixed doxygen grouping</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aed547acdacee538b3d5edb8effdabd33"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#aed547acdacee538b3d5edb8effdabd33">XPUF_REGISTRATION</a>&#160;&#160;&#160;(0x0U)</td></tr>
<tr class="memdesc:aed547acdacee538b3d5edb8effdabd33"><td class="mdescLeft">&#160;</td><td class="mdescRight">PUF Operation - PUF Registration.  <a href="#aed547acdacee538b3d5edb8effdabd33">More...</a><br/></td></tr>
<tr class="separator:aed547acdacee538b3d5edb8effdabd33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9fd28d7474a740dad170102dd6e8d8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#aa9fd28d7474a740dad170102dd6e8d8f">XPUF_REGEN_ON_DEMAND</a>&#160;&#160;&#160;(0x1U)</td></tr>
<tr class="memdesc:aa9fd28d7474a740dad170102dd6e8d8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">PUF Operation - PUF On demand regeneration.  <a href="#aa9fd28d7474a740dad170102dd6e8d8f">More...</a><br/></td></tr>
<tr class="separator:aa9fd28d7474a740dad170102dd6e8d8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9382543db8550e50f67432edcab2413e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#a9382543db8550e50f67432edcab2413e">XPUF_REGEN_ID_ONLY</a>&#160;&#160;&#160;(0x2U)</td></tr>
<tr class="memdesc:a9382543db8550e50f67432edcab2413e"><td class="mdescLeft">&#160;</td><td class="mdescRight">PUF Operation - PUF ID only regeneration.  <a href="#a9382543db8550e50f67432edcab2413e">More...</a><br/></td></tr>
<tr class="separator:a9382543db8550e50f67432edcab2413e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2f5f1a1c014713b1da61a2f29472af4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#ad2f5f1a1c014713b1da61a2f29472af4">XPUF_SYNDROME_MODE_4K</a>&#160;&#160;&#160;(0x0U)</td></tr>
<tr class="memdesc:ad2f5f1a1c014713b1da61a2f29472af4"><td class="mdescLeft">&#160;</td><td class="mdescRight">PUF Mode - 4K Syndrome mode.  <a href="#ad2f5f1a1c014713b1da61a2f29472af4">More...</a><br/></td></tr>
<tr class="separator:ad2f5f1a1c014713b1da61a2f29472af4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accc30269ffccadce90c4a12261a9fb55"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#accc30269ffccadce90c4a12261a9fb55">XPUF_SHUTTER_VALUE</a>&#160;&#160;&#160;(0x81000100U)</td></tr>
<tr class="memdesc:accc30269ffccadce90c4a12261a9fb55"><td class="mdescLeft">&#160;</td><td class="mdescRight">PUF Shutter Value - Versal.  <a href="#accc30269ffccadce90c4a12261a9fb55">More...</a><br/></td></tr>
<tr class="separator:accc30269ffccadce90c4a12261a9fb55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3c1267c815426a6c68ff76e7618f6d01"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#a3c1267c815426a6c68ff76e7618f6d01">XPuf_ReadOption</a> { <a class="el" href="xpuf__defs_8h.html#a3c1267c815426a6c68ff76e7618f6d01a840cf45a2b10a58c8ea5c0790d4dda7d">XPUF_READ_FROM_RAM</a>,
<a class="el" href="xpuf__defs_8h.html#a3c1267c815426a6c68ff76e7618f6d01a0980f439bee315d71a0a9ad2ce1ab2ef">XPUF_READ_FROM_EFUSE_CACHE</a>
 }</td></tr>
<tr class="separator:a3c1267c815426a6c68ff76e7618f6d01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e19f3b163a88acd0d435dbb8f3e6980"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980">XPuf_ApiId</a> { <br/>
&#160;&#160;<a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980a6b2a951369bb1914dc8d535fc14f79f5">XPUF_API_FEATURES</a> = 0U,
<a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980a811924cbfc83968c698b096d31214a80">XPUF_PUF_REGISTRATION</a>,
<a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980ae0d7de4596d15f543923f5ed09565e84">XPUF_PUF_REGENERATION</a>,
<a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980a64590602f5af8086c2a85ec6f4812c83">XPUF_PUF_CLEAR_PUF_ID</a>,
<br/>
&#160;&#160;<a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980a14aaef4e5f66273ab69c5a426f66665d">XPUF_API_MAX</a>
<br/>
 }</td></tr>
<tr class="separator:a2e19f3b163a88acd0d435dbb8f3e6980"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a9382543db8550e50f67432edcab2413e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPUF_REGEN_ID_ONLY&#160;&#160;&#160;(0x2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PUF Operation - PUF ID only regeneration. </p>

<p>Referenced by <a class="el" href="group__xpuf__server__apis.html#ga2f60c4624b046d3f5c74d8cb01f8f90d">XPuf_Regeneration()</a>.</p>

</div>
</div>
<a class="anchor" id="aa9fd28d7474a740dad170102dd6e8d8f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPUF_REGEN_ON_DEMAND&#160;&#160;&#160;(0x1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PUF Operation - PUF On demand regeneration. </p>

<p>Referenced by <a class="el" href="group__xpuf__server__apis.html#ga2f60c4624b046d3f5c74d8cb01f8f90d">XPuf_Regeneration()</a>.</p>

</div>
</div>
<a class="anchor" id="aed547acdacee538b3d5edb8effdabd33"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPUF_REGISTRATION&#160;&#160;&#160;(0x0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PUF Operation - PUF Registration. </p>

</div>
</div>
<a class="anchor" id="accc30269ffccadce90c4a12261a9fb55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPUF_SHUTTER_VALUE&#160;&#160;&#160;(0x81000100U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PUF Shutter Value - Versal. </p>

</div>
</div>
<a class="anchor" id="ad2f5f1a1c014713b1da61a2f29472af4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPUF_SYNDROME_MODE_4K&#160;&#160;&#160;(0x0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>PUF Mode - 4K Syndrome mode. </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a2e19f3b163a88acd0d435dbb8f3e6980"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpuf__defs_8h.html#a2e19f3b163a88acd0d435dbb8f3e6980">XPuf_ApiId</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a2e19f3b163a88acd0d435dbb8f3e6980a6b2a951369bb1914dc8d535fc14f79f5"></a>XPUF_API_FEATURES</em>&nbsp;</td><td class="fielddoc">
<p>API id for features. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2e19f3b163a88acd0d435dbb8f3e6980a811924cbfc83968c698b096d31214a80"></a>XPUF_PUF_REGISTRATION</em>&nbsp;</td><td class="fielddoc">
<p>API id for PUF registration. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2e19f3b163a88acd0d435dbb8f3e6980ae0d7de4596d15f543923f5ed09565e84"></a>XPUF_PUF_REGENERATION</em>&nbsp;</td><td class="fielddoc">
<p>API id for PUF regeneration. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2e19f3b163a88acd0d435dbb8f3e6980a64590602f5af8086c2a85ec6f4812c83"></a>XPUF_PUF_CLEAR_PUF_ID</em>&nbsp;</td><td class="fielddoc">
<p>API id for PUF clear id. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2e19f3b163a88acd0d435dbb8f3e6980a14aaef4e5f66273ab69c5a426f66665d"></a>XPUF_API_MAX</em>&nbsp;</td><td class="fielddoc">
<p>Number of API features. </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="a3c1267c815426a6c68ff76e7618f6d01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpuf__defs_8h.html#a3c1267c815426a6c68ff76e7618f6d01">XPuf_ReadOption</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a3c1267c815426a6c68ff76e7618f6d01a840cf45a2b10a58c8ea5c0790d4dda7d"></a>XPUF_READ_FROM_RAM</em>&nbsp;</td><td class="fielddoc">
<p>Read helper data from memory. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3c1267c815426a6c68ff76e7618f6d01a0980f439bee315d71a0a9ad2ce1ab2ef"></a>XPUF_READ_FROM_EFUSE_CACHE</em>&nbsp;</td><td class="fielddoc">
<p>Read helper data from eFuse cache. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
